A graphical scroll bar. More...
Public Member Functions | |
ScrollBar () | |
~ScrollBar () | |
int | getCurrentMin () const |
int | getCurrentMax () const |
void | setMin (int value) |
void | setMax (int value) |
void | setActiveRange (int value) |
void | setScrollCallback (const std::function< void(ScrollBar *)> &callback) |
virtual void | scrollToMin () |
virtual void | scrollToMax () |
virtual void | setScrollFactor (float value)=0 |
virtual void | moveCurrentMinTo (int value) |
virtual void | moveCurrentMaxTo (int value) |
virtual void | scroll (float factor)=0 |
![]() | |
Component () | |
virtual | ~Component () |
Layout * | getLayout () const |
Theme * | getTheme () const |
nkMaths::Point | getPositionInParent () const |
nkMaths::Point | getPositionInScreen () const |
int | getWidth () const |
int | getHeight () const |
nkMaths::Rectangle | getAreaInParent () const |
nkMaths::Rectangle | getAreaInScreen () const |
virtual nkMaths::Point | getBorderExtents () const |
virtual int | getLayoutAllowedWidth () const |
virtual int | getLayoutAllowedHeight () const |
virtual int | getLayoutAllowedOffsetX () const |
virtual int | getLayoutAllowedOffsetY () const |
bool | isInitialized () const |
Component * | getParentComponent () const |
COMPONENT_TYPE | getComponentType () const |
const char * | getComponentName () const |
bool | getVisibility () const |
virtual const char * | getLabel () const |
void * | getData () const |
bool | isEnabled () const |
bool | isForegroundWindow () const |
unsigned int | getZDepth () const |
bool | getVisibleOnLoad () const |
virtual Layout * | setLayout (LAYOUT_TYPE layoutType) |
virtual void | setTheme (Theme *theme) |
virtual void | setPositionInParent (nkMaths::Point position) |
virtual void | setPositionInScreen (nkMaths::Point position) |
virtual void | setSize (int width, int height) |
virtual void | setWidth (int width) |
virtual void | setHeight (int height) |
void | setMinSize (unsigned int width, unsigned int height) |
void | setMaxSize (unsigned int width, unsigned int height) |
void | setRatio (float widthOverHeight) |
virtual void | setAreaInParent (const nkMaths::Rectangle &area) |
virtual void | setAreaInScreen (const nkMaths::Rectangle &area) |
virtual void | setParentComponent (Component *parent, bool makeItVisible=true) |
virtual void | setLabel (const std::string_view &label) |
void | setComponentName (const std::string_view &name) |
virtual void | setVisibility (bool value) |
void | setData (void *data) |
void | setEnabled (bool value) |
void | setVisibleOnLoad (bool value) |
void | addChild (Component *child, bool makeItVisible=true) |
void | removeChild (Component *child) |
void | removeChild (unsigned int index) |
Component * | getChild (unsigned int index) |
unsigned int | getChildIndex (Component *child) |
void | unloadWithChildren () |
void | loadWithChildren () |
void | updateZDepth () |
void | bringToForeground () |
void | focusWindow () |
nkMaths::Point | getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords) |
nkMaths::Point | getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords) |
virtual void | load ()=0 |
virtual void | unload ()=0 |
virtual void | updateWindow () |
nkImages::Image | paintToImage (bool withFrame=false) |
void | simulateEvent (const InputDescriptor &inputDescription) |
void | onSized () |
virtual void | exportClassToTree (nkExport::Node *rootNode) override |
virtual void | exportIntrospection (nkExport::Node *rootNode) |
virtual void | importClassFromTree (nkExport::Node *rootNode) override |
![]() | |
Exportable () | |
virtual | ~Exportable () |
A graphical scroll bar.
nkWinUi::ScrollBar::ScrollBar | ( | ) |
Constructor.
nkWinUi::ScrollBar::~ScrollBar | ( | ) |
Destructor.
int nkWinUi::ScrollBar::getCurrentMin | ( | ) | const |
int nkWinUi::ScrollBar::getCurrentMax | ( | ) | const |
void nkWinUi::ScrollBar::setMin | ( | int | value | ) |
Sets the minimal scrolling value.
value | The minimal value to set. |
void nkWinUi::ScrollBar::setMax | ( | int | value | ) |
Sets the maximal scrolling value.
value | The maximal value to set. |
void nkWinUi::ScrollBar::setActiveRange | ( | int | value | ) |
Sets the active range, within the minimal and maximal values possible. Will be clamped else. Expressed relative to the current position.
value | The range to set. |
void nkWinUi::ScrollBar::setScrollCallback | ( | const std::function< void(ScrollBar *)> & | callback | ) |
Sets the function to call each time scrolling occurs within the scroll bar.
callback | The callback to call when scrolling input occurs. |
|
virtual |
Scrolls to the minimal value.
|
virtual |
Scrolls to the maximal value, given active range and maximum.
|
pure virtual |
Sets the scrolling factor.
value | The factor to use. |
|
virtual |
Moves the current scroll position.
value | Where to move it to. |
|
virtual |
Moves the current scroll position, taking into account the range with it.
value | Where to move it to. |
|
pure virtual |
Scrolls by a factor. For instance, a factor given by a mouse wheel.
factor | The factor to use for scrolling. |